home *** CD-ROM | disk | FTP | other *** search
/ Die Speccy' 97 / Die Speccy' 97.iso / amiga_system / the_aminet / util / cli / flashfind1_1.lha / FlashFind 1.1 / FlashFind.doc < prev    next >
Text File  |  1995-09-28  |  5KB  |  169 lines
  1.             _____ _           _     _____ _           _    _   _ 
  2.            |  ___| | __ _ ___| |__ |  ___(_)_ __   __| |  / | / |
  3.            | |_  | |/ _` / __| '_ \| |_  | | '_ \ / _` |  | | | |
  4.            |  _| | | (_| \__ \ | | |  _| | | | | | (_| |  | |_| |
  5.            |_|   |_|\__,_|___/_| |_|_|   |_|_| |_|\__,_|  |_(_)_|
  6.  
  7.                             ⌐ 1995 by Frank Wⁿrkner
  8.                               All Rights Reserved
  9.  
  10.  
  11. COPYRIGHT NOTE
  12. »»»»»»»»»»»»»»
  13. The program FlashFind is copyrighted ⌐ 1995 by Frank Wⁿrkner.
  14. All rights reserved.
  15.  
  16. FlashFind is FREEWARE.  This program may be freely distributed as long as
  17.   - the executable and documentation remain unchanged and
  18.     are included in the distribution
  19.   - no other charge is made than to cover time and copying costs
  20.  
  21.  
  22. DISCLAIMER
  23. »»»»»»»»»»
  24. No warranties of any kind are made as to the functionality of this
  25. program. You are using it ENTIRELY at your own risk.
  26.  
  27.  
  28. SYSTEM REQUIREMENTS
  29. »»»»»»»»»»»»»»»»»»»
  30. You need OS2.0 or higher!!!
  31.  
  32.  
  33. QUICK OVERVIEW
  34. »»»»»»»»»»»»»»
  35. Tired of slow text search tools which pretend to be fast?
  36. Want something real faaast?
  37. Try FlashFind. It searches through a 2.5MB text on hard disc in 20 seconds
  38. on a plain 68000er!!! For comparison c:search is about 20 times slower.
  39. FlashFind uses a highly optimised, assembler coded Boyer-Moore search
  40. algorithm. Additional speed is gained by using asynchron IO.
  41.  
  42.  
  43. USAGE
  44. »»»»»
  45. Nearby FlashFind is pure and can be made resident. You can quit FlashFind
  46. with CTRL-C (surprise!) and skipp to the next file with CTRL-D.
  47. FlashFind has the following template:
  48.  
  49.      FROM/M/A,SEARCH/A,ALL/S,NUM/S,QUIET/S,P=PATTERN/S,CS=CASESENSITIVE/S,
  50.      INVERT/S,NH=NOHIGHLIGHT/S,V=VERBOSE/S,BIN/S,NO=NOPREFS/S,MAXHIT/K/N
  51.  
  52. FROM/M/A
  53.      The textfile, directory or any valid AmigaDOS wildcard that should
  54.      be searched for.
  55.  
  56. SEARCH/A
  57.      The text you want to find.
  58.  
  59. ALL/S
  60.      Also recursively search within subdirectorys.
  61.  
  62. NUM/S
  63.      Show line numbers before matching lines.
  64.      This option does slow down search speed!
  65.  
  66. QUIET/S
  67.      If you search more than one file, the filename will be written first.
  68.      So you always will see from which file the text came from. Set QUIET
  69.      to see absolute no filenames. Filenames from files in which nothing
  70.      is found are never printed independent of the QUIET switch.
  71.  
  72. P=PATTERN/S
  73.      Use pattern matching instead of substring search.
  74.      SEARCH must be a valid AmigaDOS wildcard. Each textline is matched
  75.      with your pattern. This is MUCH slower than substring search!
  76.  
  77. CS=CASESENSITIVE/S
  78.      By default search is case insensitive. Use this to get case sensitive
  79.      search (also possible in combination with PATTERN)
  80.  
  81. INVERT/S
  82.      Show all lines that do not match.
  83.      This option does slow down search speed!
  84.  
  85. NH=NOHIGHLIGHT/S
  86.      By default the text found within the line is colored. The filename of
  87.      the file where the text was found is also colored. Use this switch to
  88.      turn coloring off.
  89.  
  90. V=VERBOSE/S
  91.      Show the filename that is currently processed. This works even if you
  92.      redirect the output into a file, e.g. FlashFind ram: foo all >hits
  93.  
  94. BIN/S
  95.      By default each file is checked first if it contains binary. If so
  96.      it is silently skipped. Use this switch to force the search even
  97.      within binary files.
  98.  
  99. NO=NOPREFS/S
  100.      FlashFind looks into the environment variable `FlashFind.prefs' to
  101.      read your default options (exept FROM, SEARCH and NOPREFS).
  102.      Setting NOPREFS will cause FlashFind to ignore this variable.
  103.  
  104. MAXHIT/K/N
  105.      Only show MAXHIT matching lines of one file. Default is to show all
  106.      matching lines.
  107.  
  108.  
  109. EXAMPLES
  110. »»»»»»»»
  111. FlashFind Include:*.h ram: CTRL_C all
  112. Search `CTRL_C' within every file of ram: and every file in Include: ending
  113. with .h (both times including subdirectories). The search is case insensitive.
  114.  
  115. FlashFind does also set the return code to 5 if no matching line was found.
  116. So it is easy to use within script's, e.g.
  117. FlashFind >NIL: Spool:Mail flame MAXHIT=1
  118. IF WARN
  119.   show Spool:Mail
  120. ELSE
  121.   delete Spool:Mail
  122. ENDIF
  123.  
  124. How can I save my default options? I want VERBOSE, NUM, ALL and MAXHIT=50.
  125. setenv FlashFind.prefs "VERBOSE NUM ALL MAXHIT=50"
  126. copy env:FlashFind.prefs envarc:
  127.  
  128.  
  129. HISTORY
  130. »»»»»»»
  131. 1.0
  132.      first release
  133.  
  134. 1.1
  135.      o FlashFind now first checks if the file really is a text file (but also
  136.        can be forced to search all files with BIN switch)
  137.  
  138.      o now gives the filename where a problem appears
  139.  
  140.      o if an error occurs in a file FlashFind prints the error message
  141.        and continues with the next file (instead of quiting as in 1.0)
  142.  
  143.      o line numbering possible through NUM switch.
  144.        Too many asked for this :-)
  145.      
  146.      o INVERT switch to show all lines that do not match
  147.  
  148.      o VERBOSE switch to see which files are processed
  149.      
  150.      o MAXHIT to limit the number of matching lines
  151.  
  152.      o favourite options can be put into environment variable
  153.        `FlashFind.prefs'
  154.  
  155.      o possible to use CTRL-D to skipp to next file
  156.  
  157.  
  158. If you have comments, suggestions, criticism, bug reports etc.
  159. send mail to
  160.  
  161.                 Frank Wⁿrkner
  162.                 Georgenschwaigstr. 22
  163.                 D-80807 Mⁿnchen
  164.                 Germany
  165.  
  166.                 or
  167.  
  168.                 E-Mail: wuerkner@informatik.tu-muenchen.de
  169.